GET Assets?assetTypeId={assetTypeId}&assetGroupId={assetGroupId}&parentAssetId={parentAssetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves assets for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
assetGroupId |
Id of the asset group |
globally unique identifier |
None. |
parentAssetId |
Id of the parent asset |
globally unique identifier |
None. |
take |
Number of assets to retrieve. Default is all assets |
integer |
None. |
skip |
Number of assets to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the assets before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of assets.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Asset |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "AssetId": "bb60d6a9-1346-4dd4-add3-292413927d72", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "79b4009c-c1cd-4a09-b779-8aca9170aafa", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "63979c32-0bd7-43cd-b49f-79f0a2c8cc5c", "CreateDate": "2024-05-02T05:35:05.0438607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-02T05:35:05.0438607-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "370bf6a6-af46-499d-892f-c15491aba37a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "MeasurementValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9e154e7b-8367-401a-9f12-388671544491", "CreateDate": "2024-05-02T05:35:05.0438607-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:35:05.0438607-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "MeasurementValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "692e5225-1e61-40e3-b5b6-25825aa47906", "CreateDate": "2024-05-02T05:35:05.0438607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-02T05:35:05.0438607-07:00", "LastModifiedUser": "sample string 8" }, { "AssetId": "bb60d6a9-1346-4dd4-add3-292413927d72", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "79b4009c-c1cd-4a09-b779-8aca9170aafa", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "63979c32-0bd7-43cd-b49f-79f0a2c8cc5c", "CreateDate": "2024-05-02T05:35:05.0438607-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-02T05:35:05.0438607-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "370bf6a6-af46-499d-892f-c15491aba37a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "MeasurementValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9e154e7b-8367-401a-9f12-388671544491", "CreateDate": "2024-05-02T05:35:05.0438607-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T05:35:05.0438607-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "MeasurementValueNeededDate": "2024-05-02T05:35:05.0438607-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "692e5225-1e61-40e3-b5b6-25825aa47906", "CreateDate": "2024-05-02T05:35:05.0438607-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-02T05:35:05.0438607-07:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }